Skip to content

docs(workspaces): match the current sidebar and pin naming - #8435

Open
diip3sh wants to merge 2 commits into
ParadevAI:mainfrom
diip3sh:docs/sidebar-pin-naming
Open

diip3sh wants to merge 2 commits into
ParadevAI:mainfrom
diip3sh:docs/sidebar-pin-naming

Conversation

@diip3sh

@diip3sh diip3sh commented Oct 13, 2026 •

Copy link
Copy Markdown

What & why

Refs #6994.

#6994 says "Pin" meant two different things. #7000 fixed the app side: the Workspaces page now says "Show on Sidebar" / "Hide from Sidebar", and the sidebar keeps "Pin" / "Unpin" for the Pinned section. apps/docs/content/docs/workspaces.mdx still used the old wording, so this PR updates it:

With this, #6994 can be closed.

Not included: the marketing site still says "Pin to Sidebar".

Screenshots

The labels the docs now use, in the dev app:

Sidebar context menu Workspaces page, Filter → Sidebar
Right-click menu on a sidebar workspace, with Pin as the first item Workspaces page Filter menu with PR state, Agent, Created by, and Sidebar; the Sidebar submenu shows All workspaces, Shown, and Hidden

The sidebar shot was taken on the #8434 branch, so the worktree row shows that PR's fork icon.

How I tested it

Docs only. I checked the wording against the labels on main: V2WorkspaceContextMenu, V2WorkspacesHeader (Filter menu, device title menu, project menu), v2WorkspacesFilterStore, the v2-workspaces route search params (device, projects, and the Filter values all sync to the URL), and the sidebar workspace context menu. None of these files changed on main between a8c6da1 and cc31d02.

Checklist

  • PR title follows conventional commits (type(scope): subject)
  • bun run lint and bun run typecheck pass (CI fails on lint warnings too). Lint passes on the merge with main at cc31d02. I did not run the type check: this PR changes one .mdx file, which it does not check.
  • "Allow edits from maintainers" is checked on fork PRs

Summary by cubic

Aligns the workspaces docs with the current sidebar and Workspaces-page naming, so "Pin" now refers only to the pinned section at the top of the sidebar. The Filter menu is now listed as PR state, Agent, Created by, and Sidebar, with Device and Project moved to the page title and the menu next to Filter. Closes #6994.

Written for commit 89d26a4. Summary will update on new commits.

View guided diff

Summary by CodeRabbit

  • Documentation
    • Updated workspace pinning instructions to use the sidebar’s Pin and Unpin options.
    • Clarified how to select a device and project, and documented the Sidebar filter options: All workspaces, Shown, and Hidden.

The Workspaces-page action was renamed to "Show on Sidebar"/"Hide from
Sidebar" and the filter to "Sidebar" (Shown/Hidden) in ParadevAI#7000, so "Pin"
now only means the pinned section at the top of the sidebar. Update the
docs that still pointed users at the old "Pin to Sidebar" label and the
old Pinned/Unpinned filter options.

Refs ParadevAI#6994

Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 0f4681d3-ab6f-4adc-aad8-76652f0a6a82
📥 Commits

Reviewing files that changed from the base of the PR and between a8c6da1 and 89d26a4.

📒 Files selected for processing: 1
  • apps/docs/content/docs/workspaces.mdx

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 6 remain after this review.

📝 Walkthrough

The workspace documentation now describes the Pin and Unpin actions, device and project selection, and the Sidebar filter options.

Changes: Workspace documentation

Layer / File(s) Summary
Document workspace controls
apps/docs/content/docs/workspaces.mdx
The pinning instructions use Pin and Unpin. The toolbar instructions describe device selection in the page title, project selection beside Filter, and Sidebar filter options for All workspaces, Shown, and Hidden.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: kitenite

Merge Risk: ⚪ Minimal · up to 89d26

This documentation update presents no actionable merge-blocking risk in the supplied review context.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Linked Issues check Warning Issue #6994 proposes keeping Pin to Sidebar / Unpin from Sidebar on the Workspaces page and renaming the sidebar placement action to Favorite with a FAVORITES section. This PR document… Align the Workspaces and sidebar labels with the requirements in #6994, then update apps/docs/content/docs/workspaces.mdx to describe those labels.
Passed Passed checks: 4 passed
Check name Status Explanation
Description check Passed The description follows the required template. It explains the documentation changes, testing performed, screenshots, checklist status, and the reason typecheck was not run.
Title check Passed The title is concise, uses conventional commit format, and accurately summarizes the documentation update to sidebar and pin terminology.
Out of Scope Changes check Passed The diff changes only apps/docs/content/docs/workspaces.mdx. Each changed statement covers the workspace pinning or filtering terminology described in the PR objective and linked issue context. No u…
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Linked Issues check

Explanation

Issue #6994 proposes keeping Pin to Sidebar / Unpin from Sidebar on the Workspaces page and renaming the sidebar placement action to Favorite with a FAVORITES section. This PR documents the opposite naming: Pin / Unpin in the sidebar and Sidebar with Shown / Hidden on the Workspaces page. The diff changes documentation only and does not establish implementation of the linked issue proposal.

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Project and Device are not in the Filter menu. Since ParadevAI#6901 the device is
picked from the page title and projects from their own menu, and Filter
holds PR state, Agent, Created by, and Sidebar. The Filter count badge
counts only those four.

Refs ParadevAI#6994

Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
@diip3sh
diip3sh marked this pull request as ready for review October 14, 2026 07:30
@greptile-apps

greptile-apps Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

[Low impact] This documentation-only change appears safe to merge.

Summary

Updates the workspace docs to match the current app:

  • The Workspaces guide names the sidebar and filters like the app.

No actionable issues found.

Reviews (1) · Last reviewed commit: "docs(workspaces): list the Filter menu i..." · Reviewed by Greptile

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sidebar & Workspaces: "Pin" is used for two different behaviors

1 participant